All Questions
Tagged with documentationterminology
20 questions
2votes
7answers
662views
Is there a term that describes the property of being synchronous vs asynchronous?
Is there a term that describes the property of being synchronous vs asynchronous? The term that most naturally comes to mind is "synchronicity", however I only see this term being use in ...
- 139
1vote
2answers
295views
What does "legacy signature" mean?
I see the term legacy signature a lot in the documentation of programming languages. For example in the php documentation : Passing the separator after the array (i.e. using the legacy signature) ...
1vote
1answer
190views
Code reference symbols in documentation, comments and pull requests?
I've seen method references in PRs and comments and documentation but it's unclear what the specific symbology means. E.g. ClassName#myMethod or ClassName::myMethod or what about ClassName::CONSTANT ...
- 147
0votes
2answers
198views
Errors that don't make code behave wrong from user's point of view - how would you call them?
var file_extension = 'txt'; if (file_extension === 'txt') alert('plain text'); else if (file_extension === 'md') alert('markdown'); var file_extension = 'txt'; if (file_extension === 'txt') ...
- 205
5votes
4answers
234views
How to describe a function argument that is used as a hint/best-effort?
Say I have a server exposing an api that let me retrieve 'things', there are a lot of things, and as such retrieving all things at once could take down the server, hence the exposed API returns ...
- 169
7votes
4answers
4kviews
What is the antonym to “legacy code”? [closed]
I am writing a software documentation and I need a antonym to "legacy code". Is there any established word for the antonym to "legacy code"? I'll need this antonym to describe that code which was ...
- 189
6votes
1answer
651views
Name of notation used when documenting command line parameters
Often, command line parameters are documented using a vaguely EBNF-ish notation such as the following: The output of dir /? on Windows: DIR [drive:][path][filename] [/A[[:]attributes]] [/B] [/C] [/D] ...
- 465
6votes
3answers
9kviews
What do you call parentheses operators?
In most programming languages documentation where they talk about operators +-*/=<> they also include ()[] as operators. There are unary operators, multiplicative operators, additive operators, ...
- 13.1k
0votes
1answer
1kviews
Are there differences between Functionality and Functional Requirements [closed]
I'm writing some documentation in a project in a tool. In this tool of mine, and write in specific area, I have here use Case, Business Rule, N-Diagram Types, and Functionality and Functional ...
- 717
12votes
3answers
3kviews
How to document experimental or incomplete APIs like @deprecated?
Is there a good term that is similar but different than "deprecate" to mean that a method or API is in the code base but should not be used because its implementation is not complete or will likely ...
- 223
3votes
4answers
843views
What Does It Usually Mean for a Feature to be "Supported"?
I'm currently working some testing for a particular area of an application. I had to write some automated tests for a particular feature but due to the circumstances, this was not easy to do. When I ...
- 3,708
7votes
4answers
5kviews
Is functional spec a "design document"?
So I have been a bit lost in the terms, so first of all I present you what I have learned so far: System requirements specification - what users want, what the system should do Functional requirement -...
- 4,946
12votes
4answers
492views
What exactly comprises 'Documentation'?
When we say 'documentation' for a software product, what does that include and what shouldn't that include? For example, a recent question asked if comments are considered documentation? But there ...
- 11.2k
8votes
6answers
4kviews
What is a good non-technical example of a cumulative error?
I'm working on a report which needs to explain in non-technical terms the effects of a cumulative error, and why it is of importance to use absolute calculations. Definition of 'cumulative error' ...
- 5,834
15votes
5answers
49kviews
What is "Problem Domain"
I have to document my program for a school project and we have section called "problem domain" but I have no idea what to discuss in this section. So the question is: What should be discussed in the ...
